Rename ROOT component to streaming (main/26.1)#1705
Open
JakeSCahill wants to merge 16 commits into
Open
Conversation
- Changed component name from ROOT to streaming - Expanded page-header-data with full metadata for unified navigation: - title: Streaming - section: Data Platform - parent-component: self-managed - description: Redpanda broker and rpk CLI - icon: activity - This is for main branch (26.1) which is 'latest' for cloud-docs includes
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR performs a comprehensive refactoring of the documentation site configuration and cross-references. The Antora site component is renamed from Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Author
|
Jira: DOC-2180 |
- Updated xrefs: redpanda-connect → connect - Updated xrefs: redpanda-cloud → cloud-data-platform - Updated xrefs: redpanda-labs → labs - Updated self-references: ROOT → streaming - Updated context-switcher attributes - Updated image references This ensures all cross-component references work after component renames.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
modules/reference/partials/rpk-cloud-byoc-concept.adoc (1)
9-9: ⚡ Quick winUse auto-title xref text instead of hard-coded link text.
Line 9 hard-codes
Cloud API; using empty brackets keeps link text in sync with the target page title.♻️ Proposed fix
-NOTE: To create a BYOC cluster, use the xref:cloud-data-platform:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[Cloud API] or the Redpanda Cloud UI. The UI contains the parameters necessary to run `rpk cloud byoc apply` with your cloud provider. +NOTE: To create a BYOC cluster, use xref:cloud-data-platform:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[] or the Redpanda Cloud UI. The UI contains the parameters necessary to run `rpk cloud byoc apply` with your cloud provider.Based on learnings: AsciiDoc linking should prefer
xref:...[]so link text is pulled from the target document title.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/reference/partials/rpk-cloud-byoc-concept.adoc` at line 9, Replace the hard-coded link text in the xref target "xref:cloud-data-platform:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[Cloud API]" with an empty bracket form so the link pulls the target page title automatically (use xref:cloud-data-platform:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[]); update the single occurrence in the rpk-cloud-byoc-concept.adoc line that contains that xref to use the auto-title form.modules/deploy/partials/kubernetes/guides/next-steps.adoc (1)
3-3: ⚡ Quick winUse auto-title xref rendering for consistency.
Prefer empty brackets here so the target page title is sourced automatically and stays in sync.
♻️ Proposed change
-* xref:labs:ROOT:index.adoc[Try an example in Redpanda Labs] +* xref:labs:ROOT:index.adoc[]Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/deploy/partials/kubernetes/guides/next-steps.adoc` at line 3, Replace the explicit link text in the xref so the target's title is pulled automatically: locate the xref entry "xref:labs:ROOT:index.adoc[Try an example in Redpanda Labs]" and change it to use empty brackets "xref:labs:ROOT:index.adoc[]" so the referenced document's title is rendered automatically and stays in sync.modules/deploy/pages/kafka-connect/index.adoc (1)
7-7: ⚡ Quick winUse empty-bracket xref to avoid hard-coded title text.
At Line 7, switch to
xref:connect:home:index.adoc[].Based on learnings: AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.Proposed tweak
-TIP: Try xref:connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. +TIP: Try xref:connect:home:index.adoc[] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/deploy/pages/kafka-connect/index.adoc` at line 7, Replace the hard-coded link text in the xref by removing the bracketed title so AsciiDoc pulls the target's title automatically; change xref:connect:home:index.adoc[Redpanda Connect] to xref:connect:home:index.adoc[] (edit the occurrence of the xref string in the kafka-connect page).modules/deploy/pages/kafka-connect/deploy-kafka-connect.adoc (1)
10-10: ⚡ Quick winAlign xref with empty-bracket linking convention.
At Line 10, prefer
xref:connect:home:index.adoc[]over hard-coded title text.Based on learnings: AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.Proposed tweak
-TIP: Try xref:connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. +TIP: Try xref:connect:home:index.adoc[] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/deploy/pages/kafka-connect/deploy-kafka-connect.adoc` at line 10, Replace the explicit link text "xref:connect:home:index.adoc[Redpanda Connect]" with the empty-bracket cross-reference form "xref:connect:home:index.adoc[]" so the target document's title is used automatically; locate the occurrence of the string "xref:connect:home:index.adoc[Redpanda Connect]" in the TIP line (the line that mentions Redpanda Connect) and change the bracketed text to empty brackets, leaving the rest of the sentence unchanged.modules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adoc (1)
13-13: ⚡ Quick winUse auto-resolved xref title instead of hard-coded link text.
At Line 13, prefer
xref:connect:home:index.adoc[]to avoid title drift if the target page title changes.Based on learnings: AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.Proposed tweak
-TIP: Try xref:connect:home:index.adoc[Redpanda Connect] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations. +TIP: Try xref:connect:home:index.adoc[] for a faster way to build streaming data pipelines. It's fully compatible with the Kafka API but eliminates the complex setup and maintenance of Kafka Connect. Redpanda Connect also comes with built-in connectors to support AI integrations.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adoc` at line 13, Replace the hard-coded link text in the AsciiDoc xref "xref:connect:home:index.adoc[Redpanda Connect]" with an auto-resolving title by using empty brackets "xref:connect:home:index.adoc[]"; update the occurrence in the k-deploy-kafka-connect.adoc content (the TIP line containing xref:connect:home:index.adoc[Redpanda Connect]) so the link title is pulled from the target document automatically.modules/manage/pages/kubernetes/k-manage-connectors.adoc (1)
377-377: ⚡ Quick winPrefer empty-bracket xref for title stability.
At Line 377, use
xref:connect:home:index.adoc[]instead of hard-coded link text.Based on learnings: AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically.Proposed tweak
-- Explore xref:connect:home:index.adoc[Redpanda Connect] for simpler data pipeline creation +- Explore xref:connect:home:index.adoc[] for simpler data pipeline creation🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@modules/manage/pages/kubernetes/k-manage-connectors.adoc` at line 377, The AsciiDoc xref uses hard-coded link text "Redpanda Connect" which can drift; update the xref in k-manage-connectors.adoc (the "Explore xref:connect:home:index.adoc[Redpanda Connect]" occurrence) to use empty-bracket form xref:connect:home:index.adoc[] so the target document's title is pulled automatically and remains stable.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@modules/get-started/pages/quick-start.adoc`:
- Line 794: The xref in quick-start.adoc currently points to the stale target
"labs:ROOT:index.adoc"; update that reference so it uses the Labs module's
current root target instead of the deprecated ROOT name (replace
xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs] with the module's
correct root xref, e.g. xref:labs:index.adoc[Try more examples in Redpanda Labs]
or the actual new module target used across the docs), ensuring the link matches
the renamed Labs module.
---
Nitpick comments:
In `@modules/deploy/pages/kafka-connect/deploy-kafka-connect.adoc`:
- Line 10: Replace the explicit link text "xref:connect:home:index.adoc[Redpanda
Connect]" with the empty-bracket cross-reference form
"xref:connect:home:index.adoc[]" so the target document's title is used
automatically; locate the occurrence of the string
"xref:connect:home:index.adoc[Redpanda Connect]" in the TIP line (the line that
mentions Redpanda Connect) and change the bracketed text to empty brackets,
leaving the rest of the sentence unchanged.
In `@modules/deploy/pages/kafka-connect/index.adoc`:
- Line 7: Replace the hard-coded link text in the xref by removing the bracketed
title so AsciiDoc pulls the target's title automatically; change
xref:connect:home:index.adoc[Redpanda Connect] to xref:connect:home:index.adoc[]
(edit the occurrence of the xref string in the kafka-connect page).
In `@modules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adoc`:
- Line 13: Replace the hard-coded link text in the AsciiDoc xref
"xref:connect:home:index.adoc[Redpanda Connect]" with an auto-resolving title by
using empty brackets "xref:connect:home:index.adoc[]"; update the occurrence in
the k-deploy-kafka-connect.adoc content (the TIP line containing
xref:connect:home:index.adoc[Redpanda Connect]) so the link title is pulled from
the target document automatically.
In `@modules/deploy/partials/kubernetes/guides/next-steps.adoc`:
- Line 3: Replace the explicit link text in the xref so the target's title is
pulled automatically: locate the xref entry "xref:labs:ROOT:index.adoc[Try an
example in Redpanda Labs]" and change it to use empty brackets
"xref:labs:ROOT:index.adoc[]" so the referenced document's title is rendered
automatically and stays in sync.
In `@modules/manage/pages/kubernetes/k-manage-connectors.adoc`:
- Line 377: The AsciiDoc xref uses hard-coded link text "Redpanda Connect" which
can drift; update the xref in k-manage-connectors.adoc (the "Explore
xref:connect:home:index.adoc[Redpanda Connect]" occurrence) to use empty-bracket
form xref:connect:home:index.adoc[] so the target document's title is pulled
automatically and remains stable.
In `@modules/reference/partials/rpk-cloud-byoc-concept.adoc`:
- Line 9: Replace the hard-coded link text in the xref target
"xref:cloud-data-platform:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[Cloud
API]" with an empty bracket form so the link pulls the target page title
automatically (use
xref:cloud-data-platform:manage:api/cloud-byoc-controlplane-api.adoc#create-a-new-cluster[]);
update the single occurrence in the rpk-cloud-byoc-concept.adoc line that
contains that xref to use the auto-title form.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2600b2b0-044f-447d-a8bf-ccd8d2dc73c6
📒 Files selected for processing (43)
antora.ymlmodules/ROOT/nav.adocmodules/console/pages/config/configure-console.adocmodules/console/pages/config/connect-to-redpanda.adocmodules/console/pages/config/deserialization.adocmodules/console/pages/config/enterprise-license.adocmodules/console/pages/config/http-path-rewrites.adocmodules/console/pages/config/kafka-connect.adocmodules/console/pages/config/security/authentication.adocmodules/console/pages/config/security/authorization.adocmodules/console/pages/config/security/index.adocmodules/console/pages/config/security/tls-termination.adocmodules/console/pages/config/topic-documentation.adocmodules/console/pages/index.adocmodules/console/pages/ui/add-license.adocmodules/console/pages/ui/check-license.adocmodules/console/pages/ui/data-transforms.adocmodules/console/pages/ui/edit-topic-configuration.adocmodules/console/pages/ui/generate-bundle.adocmodules/console/pages/ui/programmable-push-filters.adocmodules/console/pages/ui/record-deserialization.adocmodules/console/pages/ui/schema-reg.adocmodules/deploy/pages/kafka-connect/deploy-kafka-connect.adocmodules/deploy/pages/kafka-connect/index.adocmodules/deploy/pages/kafka-connect/k-deploy-kafka-connect.adocmodules/deploy/partials/kubernetes/guides/next-steps.adocmodules/develop/pages/consume-data/follower-fetching.adocmodules/develop/pages/data-transforms/how-transforms-work.adocmodules/develop/pages/manage-topics/cloud-topics.adocmodules/develop/partials/http-proxy.adocmodules/get-started/pages/intro-to-events.adocmodules/get-started/pages/licensing/overview.adocmodules/get-started/pages/quick-start.adocmodules/get-started/pages/release-notes/redpanda.adocmodules/get-started/partials/install-rpk-linux.adocmodules/manage/pages/iceberg/migrate-to-iceberg-topics.adocmodules/manage/pages/kubernetes/k-manage-connectors.adocmodules/migrate/pages/kubernetes/strimzi.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-streams.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect-test.adocmodules/reference/pages/rpk/rpk-connect/rpk-connect.adocmodules/reference/partials/rpk-cloud-byoc-concept.adocmodules/shared/partials/community-supported-kc.adoc
| https://www.redpanda.com/contact[Contact Redpanda^] to discuss using Redpanda Enterprise Edition in production. | ||
|
|
||
| - xref:redpanda-labs:ROOT:index.adoc[Try more examples in Redpanda Labs] | ||
| - xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs] |
Contributor
There was a problem hiding this comment.
Update the Labs module in this xref to avoid a stale ROOT target.
Line 794 still points to labs:ROOT:index.adoc, which conflicts with this PR’s stated module-rename cleanup and is likely to cause a broken/stale docs link target.
Suggested fix
-- xref:labs:ROOT:index.adoc[Try more examples in Redpanda Labs]
+- xref:labs:streaming:index.adoc[Try more examples in Redpanda Labs]🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@modules/get-started/pages/quick-start.adoc` at line 794, The xref in
quick-start.adoc currently points to the stale target "labs:ROOT:index.adoc";
update that reference so it uses the Labs module's current root target instead
of the deprecated ROOT name (replace xref:labs:ROOT:index.adoc[Try more examples
in Redpanda Labs] with the module's correct root xref, e.g.
xref:labs:index.adoc[Try more examples in Redpanda Labs] or the actual new
module target used across the docs), ensuring the link matches the renamed Labs
module.
- Add product-name attribute to antora.yml for future maintainability
- Replace all instances of "Redpanda Self-Managed" with {product-name} in content
- Update hardcoded instances in README, CI, and test files
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Renamed page-header-data to component-metadata for clarity - Removed redundant section field (hierarchy now from page-navigation config) - Part of config-driven navigation system implementation
- Switch from component-home-v2 to component-home-v3 - Add deploy section with quickstart, K8s, and Linux options - Add popular topics and labs sections - Update page attributes for new template Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Update component name from redpanda-labs to labs - Fix openai.adoc module from redpanda-connect to connect-plugins Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add streaming: component prefix to all xrefs for single-sourcing compatibility - Comment out non-existent rpk-registry-context-list and rpk-registry-context-delete xrefs Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Only page-layout is needed; page-role is redundant as the layout automatically sets the correct role class.
Defines 4 streaming-specific AI suggestion questions that appear in the Ask AI chat drawer when viewing streaming documentation. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Resolved xref paths to use streaming: component prefix - Kept env-cloud conditional from main for version requirement - Simplified cluster properties xref path
This was referenced May 22, 2026
micheleRP
reviewed
May 22, 2026
Contributor
There was a problem hiding this comment.
Review — deep-review anchor for the 8-PR ROOT→streaming rename batch
Reviewed as the deep-review anchor for the 8-PR ROOT→streaming rename batch (#1698-#1705). All 8 branches add the same component-metadata block and apply the same cross-component xref rewrites — the rollout is internally consistent. Ready, with one cross-branch dependency to confirm.
Critical issues
None internal to this PR. One cross-branch dependency to confirm:
{product-name}attribute dependency. 29 occurrences across 10+ pages (intro-to-events.adoc,licensing/overview.adoc,quick-start.adoc,manage/cluster-maintenance/disk-utilization.adoc, etc.). The attribute is not defined in this branch'santora.yml. It resolves only viamodules/ROOT/partials/global-attributes.ymlon thesharedbranch (commit80670401, definesproduct-name: Redpanda Streaming). Confirm the production playbook still aggregatessharedinto the now-renamedstreamingcomponent; if not, every{product-name}will render as literal{product-name}. Localnpm run buildis the cheapest verification. Consider mirroring the attribute in each component'santora.ymlas belt-and-braces.
Suggestions
- Scope creep beyond rename. This PR also rewrites
modules/home/pages/index.adocto the newcomponent-home-v3layout (43 added lines of:page-deploy-*:,:page-popular-*:,:page-labs-*:attrs) and rephrasesquick-start.adocH1 from "Redpanda Self-Managed Quickstart" to "Quickstart for Redpanda Self-Managed Data Platform" plus broad "Self-Managed Redpanda" → "Redpanda Streaming" prose updates. Not blocking, but the PR title doesn't reflect the homepage redesign — call it out in the merge message. - Verify
.github/workflows/test-docs.ymlstep rename ("Test Redpanda Self-Managed quickstart" → "Test Redpanda Streaming quickstart") doesn't break any job filter or branch protection that pins the old step name.
CodeRabbit triage
CodeRabbit posted 1 actionable + 5 nitpicks, all flagging the same pattern: prefer empty-bracket xref:...[] so link text follows the target's page title. Locations: rpk-cloud-byoc-concept.adoc:9, next-steps.adoc:3, kafka-connect/index.adoc:7, kafka-connect/deploy-kafka-connect.adoc:10, kafka-connect/k-deploy-kafka-connect.adoc:13.
- Defer. All style refinements unrelated to the rename. Accept opportunistically on lines you're already touching, or sweep in a follow-up PR.
Coordination risk
- All 4 sibling repo PRs (
docs-siteredpanda-data/docs-site#173,cloud-docsredpanda-data/cloud-docs#578,rp-connect-docsredpanda-data/rp-connect-docs#427,redpanda-labsredpanda-data/redpanda-labs#285) must merge in the same window or xrefs will break across the live site. - See redpanda-data/docs-site#173 for cross-rollout notes (suggested approval order + verification steps).
- PR #1697 ("Add page-header-data for unified navigation") is closed, never merged. Its work has been folded into this PR, which now carries the new
component-metadatablock onmain.
This was referenced May 22, 2026
micheleRP
approved these changes
May 22, 2026
Contributor
micheleRP
left a comment
micheleRP
left a comment
There was a problem hiding this comment.
Approved for merge as part of the coordinated 14-PR rollout. The {product-name} cross-branch dependency (29 occurrences, defined on the shared branch) is a verification to do at merge time, not a PR-internal blocker — one local npm run build confirms it resolves. CodeRabbit's empty-bracket xref nitpicks are deferred as out-of-scope for the rename. Merge in lockstep with sibling rollout PRs (see redpanda-data/docs-site#173 for the approval / merge order).
Add page-use-parent-context flag to enable hierarchical navigation with parent context cards in the UI. This shows the Self-Managed parent card with Streaming/Connect subcards when viewing Streaming pages. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Renames the ROOT component to 'streaming' and adds unified navigation metadata for the main branch (26.1).
Changes
Why This Branch Matters
Cloud-docs includes content from 'latest' which is the main branch (26.1). This PR ensures that cloud-docs can properly include streaming content after the component rename.
Related PRs
Part of unified navigation rollout:
Testing
Build with test-unified-nav.yml playbook to verify includes from cloud-docs resolve correctly.